# coding=utf-8
import logging
import logging.handlers
from flask import request
import os

'''
定义了日志的格式 
'''
class RequestShoppingFormatter(logging.Formatter):
    """
    自定义的日志输出格式
    """

    def format(self, record):
        record.url = request.url  # 需要在日志中记录请求地址
        record.remote_addr = request.remote_addr  # 需要在日志中记录客户端的地址
        return super().format(record)


# 创建一个个性化的logger对象
def create_logger(app):
    """
    设置日志配置
    :param app: Flask中的app对象
    :return:
    """
    logging_file_dir = app.config['LOGGING_FILE_DIR']  # 日志文件所在的目录
    logging_file_max_bytes = app.config['LOGGING_FILE_MAX_BYTES']  # 日志文件最大的大小
    logging_file_backup = app.config['LOGGING_FILE_BACKUP']  # 保留备份的日志文件个数
    logging_level = app.config['LOGGING_LEVEL']  # 默认的日志级别

    # 设置日志的输出格式(针对文件)
    request_formatter = RequestShoppingFormatter(
        '[%(asctime)s] %(remote_addr)s  请求 %(url)s \t %(levelname)s 在 %(module)s %(lineno)d : %(message)s')
        #什么时间，哪个客户端（客户端的IP地址），请求，哪个URL地址，（TAB），日志级别，在，哪个模块，哪一个行 ：日志的具体内容

    # 检查如果目录不存在，则创建目录
    if os.path.isdir(logging_file_dir):
        pass
    else:
        os.mkdir(logging_file_dir)  # 如果目录不存在，创建

    '''RotatingFileHandler他的作用:设置每一个日志的大小，当日志的大小到达你设置的大小后，他会重新开一个新的日志进行编写，循环往复（每一个文件的大小基本都是一样的）'''
    # 自定义一个目录和日志文件 ，RotatingFileHandler ： 按照指定的文件大小来规定日志文件的生产规则
    # filename日志文件存放到那里，并且就什么名字（为了防止重名，系统会自动的加上后缀防止重名的发生）
    # maxBytes文件最大的大小           backupCount在文件夹中最大存几个日志
    # flask_file_handler = logging.handlers.RotatingFileHandler(filename=os.path.join(logging_file_dir, 'financial.log'),
    #                                      maxBytes=logging_file_max_bytes,
    #                                      backupCount=logging_file_backup)


    # 为了让一个进程操作一个文件，所以文件名命名： 加上当前进程的ID     os.getpid()获得当前进程的ID
    # TimedRotatingFileHandler :根据时间，来规定日志文件的生成规则  #参数解释：when有四种写法（S：按照秒为单位生成,M：按照分钟为单位生成,H：按照小数为单位生成,D：按照天为单位生成）
                                                               #interval是和上面连接在一起的，表示多久生成一个日志文件，这里的意思是：一天生成一个日志文件
                                                               #encoding写进文件的类型      backupCount最多保留几个备份的日志文件个数
    flask_file_handler = logging.handlers.TimedRotatingFileHandler(filename=os.path.join(logging_file_dir, 'financial'+'_'+str(os.getpid())+'.log'),
                                                              when='D', interval=1, encoding='utf-8',
                                                              backupCount=logging_file_backup)

    '''文件的输出格式，就用上面的两个的其中一个就行'''

    # 给当前的handler设置格式
    flask_file_handler.setFormatter(request_formatter)
    # 得到一个logger对象 ,根据包的名字
    flask_logger = logging.getLogger('financial') #写核心的业务包
    flask_logger.addHandler(flask_file_handler) #设置Handler为flask_file_handler
    flask_logger.setLevel(logging_level) #设置日志级别

    # 整个项目需要两个handler：文件，控制台
    flask_console_handler = logging.StreamHandler() #这个是输出到控制台上，他有两个Handler，一个在文件中，一个在控制台上
    flask_console_handler.setFormatter(logging.Formatter('[%(asctime)s] %(levelname)s %(module)s %(lineno)d : %('
                                                         'message)s')) #定义在控制台上输出Handler的格式

    # 当项目运行环境是debug，才用控制台输出
    if app.debug:
        flask_logger.addHandler(flask_console_handler) #添加控制台上的Handler
